home *** CD-ROM | disk | FTP | other *** search
/ Celestin Apprentice 4 / Apprentice-Release4.iso / Source Code / Libraries / C Internet Config / IC Headers ƒ / IC Component API Descriptions.h < prev    next >
Encoding:
Text File  |  1995-11-17  |  22.2 KB  |  96 lines  |  [TEXT/SPM ]
  1. rm.
  2.     Returns icPermErr if current attr is locked, new attr is locked and buf <> nil.
  3. */
  4.  
  5. pascal ICError ICCFindPrefHandle(internetConfigurationComponent inst, ConstStr255Param key, ICAttr *attr, Handle prefh)
  6. /*
  7.     Requires IC 1.2.
  8.     
  9.     You must specify a configuration before calling this routine.
  10.     If you are getting or setting multiple preferences, you should place
  11.     these calls within an ICBegin/ICEnd pair.
  12.     If you call this routine outside of such a pair, it implicitly
  13.     calls ICBegin(inst, icReadWritePerm).
  14.     This routine effectively replaces ICGetPrefHandle.
  15.     Reads the preference specified by key from the IC database into
  16.     a handle, prefh.
  17.     key must not be the empty string.
  18.     attr is set to the attributes associated with the preference.
  19.     You must set prefh to a non-nil handle before calling this routine.
  20.     If the preference does not exist, icPrefNotFoundErr is returned.
  21. */
  22.  
  23. pascal ICError ICCGetPrefHandle(internetConfigurationComponent inst, ConstStr255Param key, ICAttr *attr, Handle *prefh)
  24. /*
  25.     Requires IC 1.1.
  26.     
  27.     You must specify a configuration before calling this routine.
  28.     If you are getting or setting multiple preferences, you should place
  29.     these calls within an ICBegin/ICEnd pair.
  30.     If you call this routine outside of such a pair, it implicitly
  31.     calls ICBegin(inst, icReadOnlyPerm).
  32.     This routine is now obsolete. Use ICFindPrefHandle instead.
  33.     Reads the preference specified by key from the IC database into
  34.     a newly created handle, prefh.
  35.     key must not be the empty string.
  36.     attr is set to the attributes associated with the preference.
  37.     The incoming value of prefh is ignored.
  38.     A new handle is created in the current heap and returned in prefh.
  39.     If the routine returns an error, prefh is set to nil.
  40.     If the preference does not exist, no error is returned and prefh is set
  41.     to an empty handle.
  42. */
  43.  
  44. pascal ICError ICCSetPrefHandle(internetConfigurationComponent inst, ConstStr255Param key, ICAttr attr, Handle prefh)
  45. /*
  46.     Requires IC 1.1.
  47.     
  48.     You must specify a configuration before calling this routine.
  49.     If you are getting or setting multiple preferences, you should place
  50.     these calls within an ICBegin/ICEnd pair.
  51.     If you call this routine outside of such a pair, it implicitly
  52.     calls ICBegin(inst, icReadWritePerm).
  53.     Sets the preference specified by key from the IC database to the
  54.     value contained in prefh.
  55.     key must not be the empty string.
  56.     If prefh is nil then the preference value is not set.
  57.     If buf is not nil then the preference value is set to the data
  58.     contained in it.
  59.     If attr is ICattr_no_change then the preference attributes are not set.
  60.     Otherwise the preference attributes are set to attr.
  61.     Returns icPermErr if the previous ICBegin was passed icReadOnlyPerm.
  62.     Returns icPermErr if current attr is locked, new attr is locked and prefh <> nil.
  63. */
  64.  
  65. pascal ICError ICCCountPref(internetConfigurationComponent inst, long *count)
  66. /*
  67.     You must specify a configuration before calling this routine.
  68.     You must be inside an ICBegin/End pair to call this routine.
  69.     Counts the total number of preferences.
  70.     If the routine returns an error, count is set to 0.
  71. */
  72.  
  73. pascal ICError ICCGetIndPref(internetConfigurationComponent inst, long n, Str255 key)
  74. /*
  75.     You must specify a configuration before calling this routine.
  76.     You must be inside an ICBegin/End pair to call this routine.
  77.     Returns the key of the Nth preference.
  78.     n must be positive.
  79.     Returns icPrefNotFoundErr if n is greater than the total number of preferences.
  80.     If the routine returns an error, key is undefined.
  81. */
  82.  
  83. pascal ICError ICCDeletePref(internetConfigurationComponent inst, ConstStr255Param key)
  84. /*
  85.     You must specify a configuration before calling this routine.
  86.     You must be inside an ICBegin/End pair to call this routine.
  87.     Deletes the preference specified by key.
  88.     key must not be the empty string.
  89.     Returns icPrefNotFound if the preference specified by key is not present.
  90. */
  91.  
  92. pascal ICError ICCEnd(internetConfigurationComponent inst)
  93. /*
  94.     You must specify a configuration before calling this routine.
  95.     You must be inside an ICBegin/End pair to call this routine.
  96.     Terminates a preference sessi